<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML lang="en">
<HEAD>
 <LINK rel="StyleSheet" href="../BBWin.css">
 <TITLE>BBWinCmd</TITLE>
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 <meta name="copyright" content="Copyright &copy; 2006 by Etienne Grignon. Licenced under GPL.">
</HEAD>
<BODY>
 <H1>BBWinCmd</H1>
 <H3>Description</H3>
<p>
BBWinCmd is a diagnostic/testing command line tool for the Big Brother / Hobbit protocol.
It allow you to send messages to the hobbit server as the bb command under Unix.
BBWinCmd is installed by default in the BBWin binary directory.
</p>
<H3>Usage</H3>
<pre class="Command">
bbwincmd &lt;options...&gt;
</pre>
<p>
Sending a status :
</p>
<p class="Command">
bbwincmd.exe &lt;bbdisplay&gt;[:&lt;port&gt;] status &lt;hostname&gt; &lt;testname&gt; &lt;color&gt; &lt;text&gt; [&lt;lifetime&gt;]
</p>
<p>
Sending a data :
</p>
<p class="Command">
bbwincmd.exe &lt;bbdisplay&gt;[:&lt;port&gt;] data &lt;hostname&gt; &lt;dataname&gt; &lt;text&gt;
</p>
<p>
Sending a notify :
</p>
<p class="Command">
bbwincmd.exe &lt;bbdisplay&gt;[:&lt;port&gt;] notify &lt;hostname&gt; &lt;testname&gt; &lt;text&gt;
</p>
<p>
Sending a disable:
</p>
<p class="Command">
bbwincmd.exe &lt;bbdisplay&gt;[:&lt;port&gt;] disable &lt;hostname&gt; &lt;test&gt; &lt;duration&gt; &lt;text&gt;
</p>
<p>
Sending an enable:
</p>
<p class="Command">
bbwincmd.exe &lt;bbdisplay&gt;[:&lt;port&gt;] enable &lt;hostname&gt; &lt;test&gt;
</p>
<p>
Sending a query and get the result:
</p>
<p class="Command">
bbwincmd.exe &lt;bbdisplay&gt;[:&lt;port&gt;] query &lt;hostname&gt; &lt;test&gt;
</p>
<p>
Sending a config and get the file content:
</p>
<p class="Command">
bbwincmd.exe &lt;bbdisplay&gt;[:&lt;port&gt;] config &lt;filename&gt;
</p>
<p>
Sending a hobbit message manually written
</p>
<p class="Command">
bbwincmd.exe &lt;bbdisplay&gt;[:&lt;port&gt;] message &lt;message&gt;
</p>
<p>
Sending a drop
</p>
<p class="Command">
bbwincmd.exe &lt;bbdisplay&gt;[:&lt;port&gt;] drop &lt;hostname&gt; [&lt;testname&gt;]
</p>
<p>
Sending a hostname rename
</p>
<p class="Command">
bbwincmd.exe &lt;bbdisplay&gt;[:&lt;port&gt;] rename &lt;hostname&gt; &lt;newhostname&gt;
</p>
<p>
Sending a test rename
</p>
<p class="Command">
bbwincmd.exe &lt;bbdisplay&gt;[:&lt;port&gt;] rename &lt;hostname&gt; &lt;oldtestname&gt; &lt;newtestname&gt;
</p>
<p>
<H3>Notes</H3>
<UL>
 <LI>If no port is specified after bbdisplay, it will use hobbit tcp port 1984
 <LI>You can set your default hobbit server by setting the environment variable BBDISPLAY.
To use your environment variable, replace the &lt;bbdisplay&gt;[:&lt;port&gt;] argument by the character $
</UL>
</BODY>
</HTML>
